home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 August: Technology Seed / August 1998 ADC Seed CD.toast / Mac OS 8.5b2 / allegro-b2-pseudo-SDK / AIncludes / Icons.a < prev    next >
Encoding:
Text File  |  1998-07-17  |  51.0 KB  |  1,861 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Icons.a
  3. ;
  4. ;    Contains:    Icon Utilities and Icon Services Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Allego Seed, Use with 3.1 Universal Interfaces
  8. ;
  9. ;    Copyright:    © 1990-1998 by Apple Computer, Inc. All rights reserved
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__ICONS__') = 'UNDEFINED' THEN
  19. __ICONS__ SET 1
  20.  
  21.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  22.     include 'MacTypes.a'
  23.     ENDIF
  24.     IF &TYPE('__QUICKDRAW__') = 'UNDEFINED' THEN
  25.     include 'Quickdraw.a'
  26.     ENDIF
  27.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  28.     include 'Files.a'
  29.     ENDIF
  30.     IF &TYPE('__CODEFRAGMENTS__') = 'UNDEFINED' THEN
  31.     include 'CodeFragments.a'
  32.     ENDIF
  33.  
  34. ;  The following are icons for which there are both icon suites and SICNs. 
  35. ;  Avoid using icon resources if possible. Use IconServices instead. 
  36.  
  37. kGenericDocumentIconResource    EQU        -4000
  38. kGenericStationeryIconResource    EQU        -3985
  39. kGenericEditionFileIconResource    EQU        -3989
  40. kGenericApplicationIconResource    EQU        -3996
  41. kGenericDeskAccessoryIconResource EQU    -3991
  42. kGenericFolderIconResource        EQU        -3999
  43. kPrivateFolderIconResource        EQU        -3994
  44. kFloppyIconResource                EQU        -3998
  45. kTrashIconResource                EQU        -3993
  46. kGenericRAMDiskIconResource        EQU        -3988
  47. kGenericCDROMIconResource        EQU        -3987
  48. ;  The following are icons for which there are SICNs only. 
  49. ;  Avoid using icon resources if possible. Use IconServices instead. 
  50.  
  51. kDesktopIconResource            EQU        -3992
  52. kOpenFolderIconResource            EQU        -3997
  53. kGenericHardDiskIconResource    EQU        -3995
  54. kGenericFileServerIconResource    EQU        -3972
  55. kGenericSuitcaseIconResource    EQU        -3970
  56. kGenericMoverObjectIconResource    EQU        -3969
  57. ;  The following are icons for which there are icon suites only. 
  58. ;  Avoid using icon resources if possible. Use IconServices instead. 
  59.  
  60. kGenericPreferencesIconResource    EQU        -3971
  61. kGenericQueryDocumentIconResource EQU    -16506
  62. kGenericExtensionIconResource    EQU        -16415
  63. kSystemFolderIconResource        EQU        -3983
  64. kHelpIconResource                EQU        -20271
  65. kAppleMenuFolderIconResource    EQU        -3982
  66. ;  Obsolete. Use named constants defined above. 
  67.  
  68. genericDocumentIconResource        EQU        -4000
  69. genericStationeryIconResource    EQU        -3985
  70. genericEditionFileIconResource    EQU        -3989
  71. genericApplicationIconResource    EQU        -3996
  72. genericDeskAccessoryIconResource EQU    -3991
  73. genericFolderIconResource        EQU        -3999
  74. privateFolderIconResource        EQU        -3994
  75. floppyIconResource                EQU        -3998
  76. trashIconResource                EQU        -3993
  77. genericRAMDiskIconResource        EQU        -3988
  78. genericCDROMIconResource        EQU        -3987
  79. desktopIconResource                EQU        -3992
  80. openFolderIconResource            EQU        -3997
  81. genericHardDiskIconResource        EQU        -3995
  82. genericFileServerIconResource    EQU        -3972
  83. genericSuitcaseIconResource        EQU        -3970
  84. genericMoverObjectIconResource    EQU        -3969
  85. genericPreferencesIconResource    EQU        -3971
  86. genericQueryDocumentIconResource EQU    -16506
  87. genericExtensionIconResource    EQU        -16415
  88. systemFolderIconResource        EQU        -3983
  89. appleMenuFolderIconResource        EQU        -3982
  90. ;  Avoid using icon resources if possible. Use IconServices instead. 
  91.  
  92. kStartupFolderIconResource        EQU        -3981
  93. kOwnedFolderIconResource        EQU        -3980
  94. kDropFolderIconResource            EQU        -3979
  95. kSharedFolderIconResource        EQU        -3978
  96. kMountedFolderIconResource        EQU        -3977
  97. kControlPanelFolderIconResource    EQU        -3976
  98. kPrintMonitorFolderIconResource    EQU        -3975
  99. kPreferencesFolderIconResource    EQU        -3974
  100. kExtensionsFolderIconResource    EQU        -3973
  101. kFontsFolderIconResource        EQU        -3968
  102. kFullTrashIconResource            EQU        -3984
  103. ;  Obsolete. Use named constants defined above. 
  104.  
  105. startupFolderIconResource        EQU        -3981
  106. ownedFolderIconResource            EQU        -3980
  107. dropFolderIconResource            EQU        -3979
  108. sharedFolderIconResource        EQU        -3978
  109. mountedFolderIconResource        EQU        -3977
  110. controlPanelFolderIconResource    EQU        -3976
  111. printMonitorFolderIconResource    EQU        -3975
  112. preferencesFolderIconResource    EQU        -3974
  113. extensionsFolderIconResource    EQU        -3973
  114. fontsFolderIconResource            EQU        -3968
  115. fullTrashIconResource            EQU        -3984
  116.  
  117. kHuge1BitMask                    EQU        'ich#'
  118. kHuge4BitData                    EQU        'ich4'
  119. kHuge8BitData                    EQU        'ich8'
  120. kHuge32BitData                    EQU        'ih32'
  121. kHuge8BitMask                    EQU        'h8mk'
  122. kLarge1BitMask                    EQU        'ICN#'
  123. kLarge4BitData                    EQU        'icl4'
  124. kLarge8BitData                    EQU        'icl8'
  125. kLarge32BitData                    EQU        'il32'
  126. kLarge8BitMask                    EQU        'l8mk'
  127. kSmall1BitMask                    EQU        'ics#'
  128. kSmall4BitData                    EQU        'ics4'
  129. kSmall8BitData                    EQU        'ics8'
  130. kSmall32BitData                    EQU        'is32'
  131. kSmall8BitMask                    EQU        's8mk'
  132. kMini1BitMask                    EQU        'icm#'
  133. kMini4BitData                    EQU        'icm4'
  134. kMini8BitData                    EQU        'icm8'
  135. ;  Obsolete. Use names defined above. 
  136.  
  137. large1BitMask                    EQU        'ICN#'
  138. large4BitData                    EQU        'icl4'
  139. large8BitData                    EQU        'icl8'
  140. small1BitMask                    EQU        'ics#'
  141. small4BitData                    EQU        'ics4'
  142. small8BitData                    EQU        'ics8'
  143. mini1BitMask                    EQU        'icm#'
  144. mini4BitData                    EQU        'icm4'
  145. mini8BitData                    EQU        'icm8'
  146. ;  Alignment type values. 
  147.  
  148. kAlignNone                        EQU        $00
  149. kAlignVerticalCenter            EQU        $01
  150. kAlignTop                        EQU        $02
  151. kAlignBottom                    EQU        $03
  152. kAlignHorizontalCenter            EQU        $04
  153. kAlignAbsoluteCenter            EQU        $05
  154. kAlignCenterTop                    EQU        $06
  155. kAlignCenterBottom                EQU        $07
  156. kAlignLeft                        EQU        $08
  157. kAlignCenterLeft                EQU        $09
  158. kAlignTopLeft                    EQU        $0A
  159. kAlignBottomLeft                EQU        $0B
  160. kAlignRight                        EQU        $0C
  161. kAlignCenterRight                EQU        $0D
  162. kAlignTopRight                    EQU        $0E
  163. kAlignBottomRight                EQU        $0F
  164. ;  Obsolete. Use names defined above. 
  165.  
  166. atNone                            EQU        $00
  167. atVerticalCenter                EQU        $01
  168. atTop                            EQU        $02
  169. atBottom                        EQU        $03
  170. atHorizontalCenter                EQU        $04
  171. atAbsoluteCenter                EQU        $05
  172. atCenterTop                        EQU        $06
  173. atCenterBottom                    EQU        $07
  174. atLeft                            EQU        $08
  175. atCenterLeft                    EQU        $09
  176. atTopLeft                        EQU        $0A
  177. atBottomLeft                    EQU        $0B
  178. atRight                            EQU        $0C
  179. atCenterRight                    EQU        $0D
  180. atTopRight                        EQU        $0E
  181. atBottomRight                    EQU        $0F
  182. ; typedef SInt16                         IconAlignmentType
  183.  
  184. ;  Transform type values. 
  185.  
  186. kTransformNone                    EQU        $00
  187. kTransformDisabled                EQU        $01
  188. kTransformOffline                EQU        $02
  189. kTransformOpen                    EQU        $03
  190. kTransformLabel1                EQU        $0100
  191. kTransformLabel2                EQU        $0200
  192. kTransformLabel3                EQU        $0300
  193. kTransformLabel4                EQU        $0400
  194. kTransformLabel5                EQU        $0500
  195. kTransformLabel6                EQU        $0600
  196. kTransformLabel7                EQU        $0700
  197. kTransformSelected                EQU        $4000
  198. kTransformSelectedDisabled        EQU        $4001
  199. kTransformSelectedOffline        EQU        $4002
  200. kTransformSelectedOpen            EQU        $4003
  201. ;  Obsolete. Use names defined above. 
  202.  
  203. ttNone                            EQU        $00
  204. ttDisabled                        EQU        $01
  205. ttOffline                        EQU        $02
  206. ttOpen                            EQU        $03
  207. ttLabel1                        EQU        $0100
  208. ttLabel2                        EQU        $0200
  209. ttLabel3                        EQU        $0300
  210. ttLabel4                        EQU        $0400
  211. ttLabel5                        EQU        $0500
  212. ttLabel6                        EQU        $0600
  213. ttLabel7                        EQU        $0700
  214. ttSelected                        EQU        $4000
  215. ttSelectedDisabled                EQU        $4001
  216. ttSelectedOffline                EQU        $4002
  217. ttSelectedOpen                    EQU        $4003
  218. ; typedef SInt16                         IconTransformType
  219.  
  220. ;  Selector mask values. 
  221.  
  222. kSelectorLarge1Bit                EQU        $00000001
  223. kSelectorLarge4Bit                EQU        $00000002
  224. kSelectorLarge8Bit                EQU        $00000004
  225. kSelectorLarge32Bit                EQU        $00000008
  226. kSelectorLarge8BitMask            EQU        $00000010
  227. kSelectorSmall1Bit                EQU        $00000100
  228. kSelectorSmall4Bit                EQU        $00000200
  229. kSelectorSmall8Bit                EQU        $00000400
  230. kSelectorSmall32Bit                EQU        $00000800
  231. kSelectorSmall8BitMask            EQU        $00001000
  232. kSelectorMini1Bit                EQU        $00010000
  233. kSelectorMini4Bit                EQU        $00020000
  234. kSelectorMini8Bit                EQU        $00040000
  235. kSelectorHuge1Bit                EQU        $01000000
  236. kSelectorHuge4Bit                EQU        $02000000
  237. kSelectorHuge8Bit                EQU        $04000000
  238. kSelectorHuge32Bit                EQU        $08000000
  239. kSelectorHuge8BitMask            EQU        $10000000
  240. kSelectorAllLargeData            EQU        $000000FF
  241. kSelectorAllSmallData            EQU        $0000FF00
  242. kSelectorAllMiniData            EQU        $00FF0000
  243. kSelectorAllHugeData            EQU        $FF000000
  244. kSelectorAll1BitData            EQU        $01010101
  245. kSelectorAll4BitData            EQU        $02020202
  246. kSelectorAll8BitData            EQU        $04040404
  247. kSelectorAll32BitData            EQU        $08000808
  248. kSelectorAllAvailableData        EQU        $FFFFFFFF
  249.  
  250. ;  Obsolete. Use names defined above. 
  251.  
  252. svLarge1Bit                        EQU        $00000001
  253. svLarge4Bit                        EQU        $00000002
  254. svLarge8Bit                        EQU        $00000004
  255. svSmall1Bit                        EQU        $00000100
  256. svSmall4Bit                        EQU        $00000200
  257. svSmall8Bit                        EQU        $00000400
  258. svMini1Bit                        EQU        $00010000
  259. svMini4Bit                        EQU        $00020000
  260. svMini8Bit                        EQU        $00040000
  261. svAllLargeData                    EQU        $000000FF
  262. svAllSmallData                    EQU        $0000FF00
  263. svAllMiniData                    EQU        $00FF0000
  264. svAll1BitData                    EQU        $01010101
  265. svAll4BitData                    EQU        $02020202
  266. svAll8BitData                    EQU        $04040404
  267. svAllAvailableData                EQU        $FFFFFFFF
  268. ; typedef UInt32                         IconSelectorValue
  269.  
  270. ; typedef IconActionProcPtr             IconAction
  271.  
  272. ; typedef IconGetterProcPtr             IconGetter
  273.  
  274.     IF ¬ OLDROUTINELOCATIONS THEN
  275. CIcon                    RECORD 0
  276. iconPMap                 ds        PixMap            ; offset: $0 (0)        ; the icon's pixMap
  277. iconMask                 ds        BitMap            ; offset: $32 (50)        ; the icon's mask
  278. iconBMap                 ds        BitMap            ; offset: $40 (64)        ; the icon's bitMap
  279. iconData                 ds.l    1                ; offset: $4E (78)        ; the icon's data
  280. iconMaskData             ds.w    1                ; offset: $52 (82) <-- really an array of length one ; icon's mask and BitMap data
  281. sizeof                     EQU *                    ; size:   $54 (84)
  282.                         ENDR
  283. ; typedef struct CIcon *                CIconPtr
  284.  
  285. ; typedef CIconPtr *                    CIconHandle
  286.  
  287. ;
  288. ; pascal CIconHandle GetCIcon(SInt16 iconID)
  289. ;
  290.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  291.         _GetCIcon:    OPWORD    $AA1E
  292.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  293.         IMPORT_CFM_FUNCTION GetCIcon
  294.     ENDIF
  295.  
  296. ;
  297. ; pascal void PlotCIcon(const Rect *theRect, CIconHandle theIcon)
  298. ;
  299.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  300.         _PlotCIcon:    OPWORD    $AA1F
  301.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  302.         IMPORT_CFM_FUNCTION PlotCIcon
  303.     ENDIF
  304.  
  305. ;
  306. ; pascal void DisposeCIcon(CIconHandle theIcon)
  307. ;
  308.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  309.         _DisposeCIcon:    OPWORD    $AA25
  310.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  311.         IMPORT_CFM_FUNCTION DisposeCIcon
  312.     ENDIF
  313.  
  314.     ENDIF
  315. ;
  316. ; pascal Handle GetIcon(SInt16 iconID)
  317. ;
  318.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  319.         _GetIcon:    OPWORD    $A9BB
  320.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  321.         IMPORT_CFM_FUNCTION GetIcon
  322.     ENDIF
  323.  
  324. ;
  325. ; pascal void PlotIcon(const Rect *theRect, Handle theIcon)
  326. ;
  327.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  328.         _PlotIcon:    OPWORD    $A94B
  329.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  330.         IMPORT_CFM_FUNCTION PlotIcon
  331.     ENDIF
  332.  
  333.  
  334.  
  335. ; 
  336. ;    Note:    IconSuiteRef and IconCacheRef should be an abstract types, 
  337. ;            but too much source code already relies on them being of type Handle.
  338. ;
  339.  
  340. ; typedef Handle                         IconSuiteRef
  341.  
  342. ; typedef Handle                         IconCacheRef
  343.  
  344. ;  IconRefs are 32-bit values identifying cached icon data. IconRef 0 is invalid.
  345.  
  346.  
  347. ;
  348. ; pascal OSErr PlotIconID(const Rect *theRect, IconAlignmentType align, IconTransformType transform, SInt16 theResID)
  349. ;
  350.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  351.         Macro
  352.         _PlotIconID
  353.             move.w              #$0500,D0
  354.             dc.w                $ABC9
  355.         EndM
  356.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  357.         IMPORT_CFM_FUNCTION PlotIconID
  358.     ENDIF
  359.  
  360. ;
  361. ; pascal OSErr NewIconSuite(IconSuiteRef *theIconSuite)
  362. ;
  363.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  364.         Macro
  365.         _NewIconSuite
  366.             move.w              #$0207,D0
  367.             dc.w                $ABC9
  368.         EndM
  369.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  370.         IMPORT_CFM_FUNCTION NewIconSuite
  371.     ENDIF
  372.  
  373. ;
  374. ; pascal OSErr AddIconToSuite(Handle theIconData, IconSuiteRef theSuite, ResType theType)
  375. ;
  376.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  377.         Macro
  378.         _AddIconToSuite
  379.             move.w              #$0608,D0
  380.             dc.w                $ABC9
  381.         EndM
  382.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  383.         IMPORT_CFM_FUNCTION AddIconToSuite
  384.     ENDIF
  385.  
  386. ;
  387. ; pascal OSErr GetIconFromSuite(Handle *theIconData, IconSuiteRef theSuite, ResType theType)
  388. ;
  389.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  390.         Macro
  391.         _GetIconFromSuite
  392.             move.w              #$0609,D0
  393.             dc.w                $ABC9
  394.         EndM
  395.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  396.         IMPORT_CFM_FUNCTION GetIconFromSuite
  397.     ENDIF
  398.  
  399. ;
  400. ; pascal OSErr ForEachIconDo(IconSuiteRef theSuite, IconSelectorValue selector, IconActionUPP action, void *yourDataPtr)
  401. ;
  402.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  403.         Macro
  404.         _ForEachIconDo
  405.             move.w              #$080A,D0
  406.             dc.w                $ABC9
  407.         EndM
  408.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  409.         IMPORT_CFM_FUNCTION ForEachIconDo
  410.     ENDIF
  411.  
  412. ;
  413. ; pascal OSErr GetIconSuite(IconSuiteRef *theIconSuite, SInt16 theResID, IconSelectorValue selector)
  414. ;
  415.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  416.         Macro
  417.         _GetIconSuite
  418.             move.w              #$0501,D0
  419.             dc.w                $ABC9
  420.         EndM
  421.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  422.         IMPORT_CFM_FUNCTION GetIconSuite
  423.     ENDIF
  424.  
  425. ;
  426. ; pascal OSErr DisposeIconSuite(IconSuiteRef theIconSuite, Boolean disposeData)
  427. ;
  428.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  429.         Macro
  430.         _DisposeIconSuite
  431.             move.w              #$0302,D0
  432.             dc.w                $ABC9
  433.         EndM
  434.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  435.         IMPORT_CFM_FUNCTION DisposeIconSuite
  436.     ENDIF
  437.  
  438. ;
  439. ; pascal OSErr PlotIconSuite(const Rect *theRect, IconAlignmentType align, IconTransformType transform, IconSuiteRef theIconSuite)
  440. ;
  441.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  442.         Macro
  443.         _PlotIconSuite
  444.             move.w              #$0603,D0
  445.             dc.w                $ABC9
  446.         EndM
  447.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  448.         IMPORT_CFM_FUNCTION PlotIconSuite
  449.     ENDIF
  450.  
  451. ;
  452. ; pascal OSErr MakeIconCache(IconCacheRef *theCache, IconGetterUPP makeIcon, void *yourDataPtr)
  453. ;
  454.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  455.         Macro
  456.         _MakeIconCache
  457.             move.w              #$0604,D0
  458.             dc.w                $ABC9
  459.         EndM
  460.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  461.         IMPORT_CFM_FUNCTION MakeIconCache
  462.     ENDIF
  463.  
  464. ;
  465. ; pascal OSErr LoadIconCache(const Rect *theRect, IconAlignmentType align, IconTransformType transform, IconCacheRef theIconCache)
  466. ;
  467.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  468.         Macro
  469.         _LoadIconCache
  470.             move.w              #$0606,D0
  471.             dc.w                $ABC9
  472.         EndM
  473.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  474.         IMPORT_CFM_FUNCTION LoadIconCache
  475.     ENDIF
  476.  
  477. ;
  478. ; pascal OSErr PlotIconMethod(const Rect *theRect, IconAlignmentType align, IconTransformType transform, IconGetterUPP theMethod, void *yourDataPtr)
  479. ;
  480.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  481.         Macro
  482.         _PlotIconMethod
  483.             move.w              #$0805,D0
  484.             dc.w                $ABC9
  485.         EndM
  486.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  487.         IMPORT_CFM_FUNCTION PlotIconMethod
  488.     ENDIF
  489.  
  490. ;
  491. ; pascal OSErr GetLabel(SInt16 labelNumber, RGBColor *labelColor, Str255 labelString)
  492. ;
  493.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  494.         Macro
  495.         _GetLabel
  496.             move.w              #$050B,D0
  497.             dc.w                $ABC9
  498.         EndM
  499.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  500.         IMPORT_CFM_FUNCTION GetLabel
  501.     ENDIF
  502.  
  503. ;
  504. ; pascal Boolean PtInIconID(Point testPt, const Rect *iconRect, IconAlignmentType align, SInt16 iconID)
  505. ;
  506.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  507.         Macro
  508.         _PtInIconID
  509.             move.w              #$060D,D0
  510.             dc.w                $ABC9
  511.         EndM
  512.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  513.         IMPORT_CFM_FUNCTION PtInIconID
  514.     ENDIF
  515.  
  516. ;
  517. ; pascal Boolean PtInIconSuite(Point testPt, const Rect *iconRect, IconAlignmentType align, IconSuiteRef theIconSuite)
  518. ;
  519.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  520.         Macro
  521.         _PtInIconSuite
  522.             move.w              #$070E,D0
  523.             dc.w                $ABC9
  524.         EndM
  525.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  526.         IMPORT_CFM_FUNCTION PtInIconSuite
  527.     ENDIF
  528.  
  529. ;
  530. ; pascal Boolean PtInIconMethod(Point testPt, const Rect *iconRect, IconAlignmentType align, IconGetterUPP theMethod, void *yourDataPtr)
  531. ;
  532.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  533.         Macro
  534.         _PtInIconMethod
  535.             move.w              #$090F,D0
  536.             dc.w                $ABC9
  537.         EndM
  538.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  539.         IMPORT_CFM_FUNCTION PtInIconMethod
  540.     ENDIF
  541.  
  542. ;
  543. ; pascal Boolean RectInIconID(const Rect *testRect, const Rect *iconRect, IconAlignmentType align, SInt16 iconID)
  544. ;
  545.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  546.         Macro
  547.         _RectInIconID
  548.             move.w              #$0610,D0
  549.             dc.w                $ABC9
  550.         EndM
  551.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  552.         IMPORT_CFM_FUNCTION RectInIconID
  553.     ENDIF
  554.  
  555. ;
  556. ; pascal Boolean RectInIconSuite(const Rect *testRect, const Rect *iconRect, IconAlignmentType align, IconSuiteRef theIconSuite)
  557. ;
  558.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  559.         Macro
  560.         _RectInIconSuite
  561.             move.w              #$0711,D0
  562.             dc.w                $ABC9
  563.         EndM
  564.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  565.         IMPORT_CFM_FUNCTION RectInIconSuite
  566.     ENDIF
  567.  
  568. ;
  569. ; pascal Boolean RectInIconMethod(const Rect *testRect, const Rect *iconRect, IconAlignmentType align, IconGetterUPP theMethod, void *yourDataPtr)
  570. ;
  571.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  572.         Macro
  573.         _RectInIconMethod
  574.             move.w              #$0912,D0
  575.             dc.w                $ABC9
  576.         EndM
  577.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  578.         IMPORT_CFM_FUNCTION RectInIconMethod
  579.     ENDIF
  580.  
  581. ;
  582. ; pascal OSErr IconIDToRgn(RgnHandle theRgn, const Rect *iconRect, IconAlignmentType align, SInt16 iconID)
  583. ;
  584.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  585.         Macro
  586.         _IconIDToRgn
  587.             move.w              #$0613,D0
  588.             dc.w                $ABC9
  589.         EndM
  590.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  591.         IMPORT_CFM_FUNCTION IconIDToRgn
  592.     ENDIF
  593.  
  594. ;
  595. ; pascal OSErr IconSuiteToRgn(RgnHandle theRgn, const Rect *iconRect, IconAlignmentType align, IconSuiteRef theIconSuite)
  596. ;
  597.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  598.         Macro
  599.         _IconSuiteToRgn
  600.             move.w              #$0714,D0
  601.             dc.w                $ABC9
  602.         EndM
  603.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  604.         IMPORT_CFM_FUNCTION IconSuiteToRgn
  605.     ENDIF
  606.  
  607. ;
  608. ; pascal OSErr IconMethodToRgn(RgnHandle theRgn, const Rect *iconRect, IconAlignmentType align, IconGetterUPP theMethod, void *yourDataPtr)
  609. ;
  610.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  611.         Macro
  612.         _IconMethodToRgn
  613.             move.w              #$0915,D0
  614.             dc.w                $ABC9
  615.         EndM
  616.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  617.         IMPORT_CFM_FUNCTION IconMethodToRgn
  618.     ENDIF
  619.  
  620. ;
  621. ; pascal OSErr SetSuiteLabel(IconSuiteRef theSuite, SInt16 theLabel)
  622. ;
  623.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  624.         Macro
  625.         _SetSuiteLabel
  626.             move.w              #$0316,D0
  627.             dc.w                $ABC9
  628.         EndM
  629.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  630.         IMPORT_CFM_FUNCTION SetSuiteLabel
  631.     ENDIF
  632.  
  633. ;
  634. ; pascal SInt16 GetSuiteLabel(IconSuiteRef theSuite)
  635. ;
  636.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  637.         Macro
  638.         _GetSuiteLabel
  639.             move.w              #$0217,D0
  640.             dc.w                $ABC9
  641.         EndM
  642.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  643.         IMPORT_CFM_FUNCTION GetSuiteLabel
  644.     ENDIF
  645.  
  646. ;
  647. ; pascal OSErr GetIconCacheData(IconCacheRef theCache, void **theData)
  648. ;
  649.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  650.         Macro
  651.         _GetIconCacheData
  652.             move.w              #$0419,D0
  653.             dc.w                $ABC9
  654.         EndM
  655.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  656.         IMPORT_CFM_FUNCTION GetIconCacheData
  657.     ENDIF
  658.  
  659. ;
  660. ; pascal OSErr SetIconCacheData(IconCacheRef theCache, void *theData)
  661. ;
  662.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  663.         Macro
  664.         _SetIconCacheData
  665.             move.w              #$041A,D0
  666.             dc.w                $ABC9
  667.         EndM
  668.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  669.         IMPORT_CFM_FUNCTION SetIconCacheData
  670.     ENDIF
  671.  
  672. ;
  673. ; pascal OSErr GetIconCacheProc(IconCacheRef theCache, IconGetterUPP *theProc)
  674. ;
  675.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  676.         Macro
  677.         _GetIconCacheProc
  678.             move.w              #$041B,D0
  679.             dc.w                $ABC9
  680.         EndM
  681.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  682.         IMPORT_CFM_FUNCTION GetIconCacheProc
  683.     ENDIF
  684.  
  685. ;
  686. ; pascal OSErr SetIconCacheProc(IconCacheRef theCache, IconGetterUPP theProc)
  687. ;
  688.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  689.         Macro
  690.         _SetIconCacheProc
  691.             move.w              #$041C,D0
  692.             dc.w                $ABC9
  693.         EndM
  694.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  695.         IMPORT_CFM_FUNCTION SetIconCacheProc
  696.     ENDIF
  697.  
  698. ;
  699. ; pascal OSErr PlotIconHandle(const Rect *theRect, IconAlignmentType align, IconTransformType transform, Handle theIcon)
  700. ;
  701.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  702.         Macro
  703.         _PlotIconHandle
  704.             move.w              #$061D,D0
  705.             dc.w                $ABC9
  706.         EndM
  707.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  708.         IMPORT_CFM_FUNCTION PlotIconHandle
  709.     ENDIF
  710.  
  711. ;
  712. ; pascal OSErr PlotSICNHandle(const Rect *theRect, IconAlignmentType align, IconTransformType transform, Handle theSICN)
  713. ;
  714.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  715.         Macro
  716.         _PlotSICNHandle
  717.             move.w              #$061E,D0
  718.             dc.w                $ABC9
  719.         EndM
  720.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  721.         IMPORT_CFM_FUNCTION PlotSICNHandle
  722.     ENDIF
  723.  
  724. ;
  725. ; pascal OSErr PlotCIconHandle(const Rect *theRect, IconAlignmentType align, IconTransformType transform, CIconHandle theCIcon)
  726. ;
  727.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  728.         Macro
  729.         _PlotCIconHandle
  730.             move.w              #$061F,D0
  731.             dc.w                $ABC9
  732.         EndM
  733.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  734.         IMPORT_CFM_FUNCTION PlotCIconHandle
  735.     ENDIF
  736.  
  737.  
  738.  
  739.  
  740.  
  741.  
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748. ;   IconServices is an efficient mechanism to share icon data amongst multiple 
  749. ;   clients. It avoids duplication of data; it provides efficient caching, 
  750. ;   releasing memory when the icon data is no longer needed; it can provide
  751. ;   the appropriate icon for any filesystem object; it can provide commonly 
  752. ;   used icons (caution, note, help...); it is Appearance-savvy: the icons
  753. ;   are switched when appropriate.
  754. ;   To refer to a cached icon data, IconServices uses IconRef, a 32-bit
  755. ;   opaque value. IconRefs are reference counted. When there are no more clients 
  756. ;   for an IconRef, the bitmap memory associated with it is marked as disposeable. 
  757. ;   Two files of same type and creator with no custom icon will have the same IconRef.
  758. ;   Files with custom icons will have their own IconRef.
  759.  
  760.  
  761.  
  762.  
  763. ;   Use the special creator kSystemIconsCreator to get "standard" icons 
  764. ;   that are not associated with a file, such as the help icon.
  765.  
  766.  
  767.  
  768. kSystemIconsCreator                EQU        'macs'
  769.  
  770.  
  771. ;   Type of the predefined/generic icons. For example, the call:
  772. ;   GetIconRef(kOnSystemDisk, kSystemIconsCreator, kHelpIcon, &iconRef);
  773. ;   will retun in iconRef the IconRef for the standard help icon.
  774.  
  775.  
  776.  
  777. ;  Generic Finder icons 
  778.  
  779. kClipboardIcon                    EQU        'CLIP'
  780. kClippingUnknownTypeIcon        EQU        'clpu'
  781. kClippingPictureTypeIcon        EQU        'clpp'
  782. kClippingTextTypeIcon            EQU        'clpt'
  783. kClippingSoundTypeIcon            EQU        'clps'
  784. kDesktopIcon                    EQU        'desk'
  785. kFinderIcon                        EQU        'FNDR'
  786. kFontSuitcaseIcon                EQU        'FFIL'
  787. kFullTrashIcon                    EQU        'ftrh'
  788. kGenericApplicationIcon            EQU        'APPL'
  789. kGenericCDROMIcon                EQU        'cddr'
  790. kGenericControlPanelIcon        EQU        'APPC'
  791. kGenericControlStripModuleIcon    EQU        'sdev'
  792. kGenericComponentIcon            EQU        'thng'
  793. kGenericDeskAccessoryIcon        EQU        'APPD'
  794. kGenericDocumentIcon            EQU        'docu'
  795. kGenericEditionFileIcon            EQU        'edtf'
  796. kGenericExtensionIcon            EQU        'INIT'
  797. kGenericFileServerIcon            EQU        'srvr'
  798. kGenericFontIcon                EQU        'ffil'
  799. kGenericFontScalerIcon            EQU        'sclr'
  800. kGenericFloppyIcon                EQU        'flpy'
  801. kGenericHardDiskIcon            EQU        'hdsk'
  802. kGenericRemovableMediaIcon        EQU        'rmov'
  803. kGenericMoverObjectIcon            EQU        'movr'
  804. kGenericPCCardIcon                EQU        'pcmc'
  805. kGenericPreferencesIcon            EQU        'pref'
  806. kGenericQueryDocumentIcon        EQU        'qery'
  807. kGenericRAMDiskIcon                EQU        'ramd'
  808. kGenericSharedLibaryIcon        EQU        'shlb'
  809. kGenericStationeryIcon            EQU        'sdoc'
  810. kGenericSuitcaseIcon            EQU        'suit'
  811. kGenericWORMIcon                EQU        'worm'
  812. kInternationResourcesIcon        EQU        'ifil'
  813. kKeyboardLayoutIcon                EQU        'kfil'
  814. kSoundFileIcon                    EQU        'sfil'
  815. kSystemSuitcaseIcon                EQU        'zsys'
  816. kTrashIcon                        EQU        'trsh'
  817. kTrueTypeFontIcon                EQU        'tfil'
  818. kTrueTypeFlatFontIcon            EQU        'sfnt'
  819. kTrueTypeMultiFlatFontIcon        EQU        'ttcf'
  820. ;  Internet locations 
  821.  
  822. kInternetLocationHTTPIcon        EQU        'ilht'
  823. kInternetLocationFTPIcon        EQU        'ilft'
  824. kInternetLocationAppleShareIcon    EQU        'ilaf'
  825. kInternetLocationAppleTalkZoneIcon EQU    'ilat'
  826. kInternetLocationFileIcon        EQU        'ilfi'
  827. kInternetLocationMailIcon        EQU        'ilma'
  828. kInternetLocationNewsIcon        EQU        'ilnw'
  829. kInternetLocationGenericIcon    EQU        'ilge'
  830. ;  Folders 
  831.  
  832. kGenericFolderIcon                EQU        'fldr'
  833. kDropFolderIcon                    EQU        'dbox'
  834. kMountedFolderIcon                EQU        'mntd'
  835. kOpenFolderIcon                    EQU        'ofld'
  836. kOwnedFolderIcon                EQU        'ownd'
  837. kPrivateFolderIcon                EQU        'prvf'
  838. kSharedFolderIcon                EQU        'shfl'
  839. ;  Sharing Privileges icons 
  840.  
  841. kSharingPrivsNotApplicableIcon    EQU        'shna'
  842. kSharingPrivsReadOnlyIcon        EQU        'shro'
  843. kSharingPrivsReadWriteIcon        EQU        'shrw'
  844. kSharingPrivsUnknownIcon        EQU        'shuk'
  845. kSharingPrivsWritableIcon        EQU        'writ'
  846.  
  847. ;  Users and Groups icons 
  848.  
  849. kUserFolderIcon                    EQU        'ufld'
  850. kWorkgroupFolderIcon            EQU        'wfld'
  851. kGuestUserIcon                    EQU        'gusr'
  852. kUserIcon                        EQU        'user'
  853. kOwnerIcon                        EQU        'susr'
  854. kGroupIcon                        EQU        'grup'
  855. ;  Special folders 
  856.  
  857. kAppleExtrasFolderIcon            EQU        'aexƒ'
  858. kAppleMenuFolderIcon            EQU        'amnu'
  859. kApplicationsFolderIcon            EQU        'apps'
  860. kApplicationSupportFolderIcon    EQU        'asup'
  861. kAssistantsFolderIcon            EQU        'astƒ'
  862. kContextualMenuItemsFolderIcon    EQU        'cmnu'
  863. kControlPanelDisabledFolderIcon    EQU        'ctrD'
  864. kControlPanelFolderIcon            EQU        'ctrl'
  865. kControlStripModulesFolderIcon    EQU        'sdvƒ'
  866. kDocumentsFolderIcon            EQU        'docs'
  867. kExtensionsDisabledFolderIcon    EQU        'extD'
  868. kExtensionsFolderIcon            EQU        'extn'
  869. kFavoritesFolderIcon            EQU        'favs'
  870. kFontsFolderIcon                EQU        'font'
  871. kHelpFolderIcon                    EQU        'ƒhlp'
  872. kInternetFolderIcon                EQU        'intƒ'
  873. kInternetPlugInFolderIcon        EQU        'ƒnet'
  874. kMacOSReadMeFolderIcon            EQU        'morƒ'
  875. kPreferencesFolderIcon            EQU        'prfƒ'
  876. kPrinterDescriptionFolderIcon    EQU        'ppdf'
  877. kPrinterDriverFolderIcon        EQU        'ƒprd'
  878. kPrintMonitorFolderIcon            EQU        'prnt'
  879. kRecentApplicationsFolderIcon    EQU        'rapp'
  880. kRecentDocumentsFolderIcon        EQU        'rdoc'
  881. kRecentServersFolderIcon        EQU        'rsrv'
  882. kScriptingAdditionsFolderIcon    EQU        'ƒscr'
  883. kSharedLibrariesFolderIcon        EQU        'ƒlib'
  884. kScriptsFolderIcon                EQU        'scrƒ'
  885. kShutdownItemsDisabledFolderIcon EQU    'shdD'
  886. kShutdownItemsFolderIcon        EQU        'shdf'
  887. kSpeakableItemsFolder            EQU        'spki'
  888. kStartupItemsDisabledFolderIcon    EQU        'strD'
  889. kStartupItemsFolderIcon            EQU        'strt'
  890. kSystemExtensionDisabledFolderIcon EQU    'macD'
  891. kSystemFolderIcon                EQU        'macs'
  892. kTextEncodingsFolderIcon        EQU        'ƒtex'
  893. kAppearanceFolderIcon            EQU        'appr'
  894. kUtilitiesFolderIcon            EQU        'utiƒ'
  895. kVoicesFolderIcon                EQU        'fvoc'
  896. kColorSyncFolderIcon            EQU        'prof'
  897. kInternetSearchSitesFolderIcon    EQU        'issf'
  898. ;  Badges 
  899.  
  900. kAppleScriptBadgeIcon            EQU        'scrp'
  901. kLockedBadgeIcon                EQU        'lbdg'
  902. kMountedBadgeIcon                EQU        'mbdg'
  903. kSharedBadgeIcon                EQU        'sbdg'
  904. kAliasBadgeIcon                    EQU        'abdg'
  905. ;  Alert icons 
  906.  
  907. kAlertNoteIcon                    EQU        'note'
  908. kAlertCautionIcon                EQU        'caut'
  909. kAlertStopIcon                    EQU        'stop'
  910. ;  Networking icons 
  911.  
  912. kAppleTalkIcon                    EQU        'atlk'
  913. kAppleTalkZoneIcon                EQU        'atzn'
  914. kAFPServerIcon                    EQU        'afps'
  915. kFTPServerIcon                    EQU        'ftps'
  916. kIPFileServerIcon                EQU        'isrv'
  917. ;  Other icons 
  918.  
  919. kAppleLogoIcon                    EQU        'capl'
  920. kAppleMenuIcon                    EQU        'sapl'
  921. kBackwardArrowIcon                EQU        'baro'
  922. kFavoriteItemsIcon                EQU        'favr'
  923. kForwardArrowIcon                EQU        'faro'
  924. kGridIcon                        EQU        'grid'
  925. kHelpIcon                        EQU        'help'
  926. kKeepArrangedIcon                EQU        'arng'
  927. kLockedIcon                        EQU        'lock'
  928. kNoFilesIcon                    EQU        'nfil'
  929. kNoFolderIcon                    EQU        'nfld'
  930. kNoWriteIcon                    EQU        'nwrt'
  931. kProtectedApplicationFolderIcon    EQU        'papp'
  932. kProtectedSystemFolderIcon        EQU        'psys'
  933. kRecentItemsIcon                EQU        'rcnt'
  934. kShortcutIcon                    EQU        'shrt'
  935. kSortAscendingIcon                EQU        'asnd'
  936. kSortDescendingIcon                EQU        'dsnd'
  937. kUnlockedIcon                    EQU        'ulck'
  938. kConnectToIcon                    EQU        'cnct'
  939.  
  940. ;     Error codes range from -2580 to -2599 
  941.  
  942. invalidIconRefErr                EQU        -2580
  943. noSuchIconErr                    EQU        -2581
  944. noIconDataAvailableErr            EQU        -2582
  945.  
  946. ;     IconServicesUsageFlags 
  947. ; typedef UInt32                         IconServicesUsageFlags
  948.  
  949.  
  950. kIconServicesNormalUsageFlag    EQU        0
  951.  
  952.  
  953. ;      IconFamily 'icns' resources contain an entire IconFamily (all sizes and depths).  
  954. ;   For custom icons, icns IconFamily resources of the custom icon resource ID are fetched first before
  955. ;   the classic custom icons (individual 'ics#, ICN#, etc) are fetched.  If the fetch of the icns resource
  956. ;   succeeds then the icns is looked at exclusively for the icon data.
  957. ;   For custom icons, new icon features such as 32-bit deep icons are only fetched from the icns resource.
  958. ;   This is to avoid incompatibilities with cut & paste of new style icons with an older version of the
  959. ;   MacOS Finder.
  960. ;   DriverGestalt is called with code kdgMediaIconSuite by IconServices after calling FSM to determine a
  961. ;   driver icon for a particular device.  The result of the kdgMediaIconSuite call to DriverGestalt should
  962. ;   be a pointer an an IconFamily.  In this manner driver vendors can provide rich, detailed drive icons
  963. ;   instead of the 1-bit variety previously supported.
  964.  
  965.  
  966.  
  967. kIconFamilyType                    EQU        'icns'
  968.  
  969. IconFamilyElement        RECORD 0
  970. elementType                 ds.l    1                ; offset: $0 (0)        ;  'ICN#', 'icl8', etc...
  971. elementSize                 ds.l    1                ; offset: $4 (4)        ;  Size of this element
  972. elementData                 ds.b    1                ; offset: $8 (8) <-- really an array of length one
  973.                          ORG 10
  974. sizeof                     EQU *                    ; size:   $A (10)
  975.                         ENDR
  976. IconFamilyResource        RECORD 0
  977. resourceType             ds.l    1                ; offset: $0 (0)        ;  Always 'icns'
  978. resourceSize             ds.l    1                ; offset: $4 (4)        ;  Total size of this resource
  979. elements                 ds        IconFamilyElement ; offset: $8 (8) <-- really an array of length one
  980. sizeof                     EQU *                    ; size:   $12 (18)
  981.                         ENDR
  982. ; typedef struct IconFamilyResource *    IconFamilyPtr
  983.  
  984. ; typedef IconFamilyPtr *                IconFamilyHandle
  985.  
  986.  
  987.  
  988. ;  ==============================================================================
  989. ;   Initialization and Termination
  990. ;  ==============================================================================
  991.  
  992.  
  993.  
  994.  
  995.  
  996. ;   IconServicesInit
  997. ;   
  998. ;   Call this routine once per classic 68K application initialization.
  999. ;   This routine does not need to be called at boot time.
  1000.  
  1001.  
  1002.  
  1003. ;
  1004. ; pascal OSErr IconServicesInit(CFragInitBlockPtr initBlockPtr)
  1005. ;
  1006.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1007.         Macro
  1008.         _IconServicesInit
  1009.             moveq               #21,D0
  1010.             dc.w                $AA75
  1011.         EndM
  1012.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1013.         IMPORT_CFM_FUNCTION IconServicesInit
  1014.     ENDIF
  1015.  
  1016.  
  1017.  
  1018. ;   IconServicesTerminate:
  1019. ;   
  1020. ;   Call this routine once from the termination of a classic 68K application.
  1021. ;   This routine does not need to be called at boot time.
  1022.  
  1023.  
  1024.  
  1025. ;
  1026. ; pascal void IconServicesTerminate(void )
  1027. ;
  1028.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1029.         Macro
  1030.         _IconServicesTerminate
  1031.             moveq               #22,D0
  1032.             dc.w                $AA75
  1033.         EndM
  1034.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1035.         IMPORT_CFM_FUNCTION IconServicesTerminate
  1036.     ENDIF
  1037.  
  1038.  
  1039.  
  1040.  
  1041. ;  ==============================================================================
  1042. ;   Converting data structures
  1043. ;  ==============================================================================
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049. ;   IconRefToIconFamily
  1050. ;   This routines returns a new IconFamily that contains the data corresponding
  1051. ;   to the specified IconRef
  1052.  
  1053.  
  1054.  
  1055. ;
  1056. ; pascal OSErr IconRefToIconFamily(IconRef theIconRef, IconSelectorValue whichIcons, IconFamilyHandle *iconFamily)
  1057. ;
  1058.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1059.         Macro
  1060.         _IconRefToIconFamily
  1061.             moveq               #36,D0
  1062.             dc.w                $AA75
  1063.         EndM
  1064.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1065.         IMPORT_CFM_FUNCTION IconRefToIconFamily
  1066.     ENDIF
  1067.  
  1068.  
  1069.  
  1070. ;   IconFamilyToIconSuite
  1071. ;   This routines transfers the data in an icon family into an icon suite.
  1072.  
  1073.  
  1074.  
  1075. ;
  1076. ; pascal OSErr IconFamilyToIconSuite(IconFamilyHandle iconFamily, IconSelectorValue whichIcons, IconSuiteRef *iconSuite)
  1077. ;
  1078.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1079.         Macro
  1080.         _IconFamilyToIconSuite
  1081.             moveq               #37,D0
  1082.             dc.w                $AA75
  1083.         EndM
  1084.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1085.         IMPORT_CFM_FUNCTION IconFamilyToIconSuite
  1086.     ENDIF
  1087.  
  1088.  
  1089.  
  1090. ;   IconSuiteToIconFamily
  1091. ;   This routines transfers the data in an icon suite into an icon family.
  1092.  
  1093.  
  1094.  
  1095. ;
  1096. ; pascal OSErr IconSuiteToIconFamily(IconSuiteRef iconSuite, IconSelectorValue whichIcons, IconFamilyHandle *iconFamily)
  1097. ;
  1098.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1099.         Macro
  1100.         _IconSuiteToIconFamily
  1101.             moveq               #38,D0
  1102.             dc.w                $AA75
  1103.         EndM
  1104.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1105.         IMPORT_CFM_FUNCTION IconSuiteToIconFamily
  1106.     ENDIF
  1107.  
  1108.  
  1109.  
  1110. ;   SetIconFamilyData
  1111. ;   Change the data of an icon family. The data is copied.
  1112. ;   The type can be one of the icon type, or 'PICT'
  1113. ;   The data will be compressed if needed.
  1114.  
  1115.  
  1116.  
  1117. ;
  1118. ; pascal OSErr SetIconFamilyData(IconFamilyHandle iconFamily, OSType iconType, Handle h)
  1119. ;
  1120.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1121.         Macro
  1122.         _SetIconFamilyData
  1123.             moveq               #48,D0
  1124.             dc.w                $AA75
  1125.         EndM
  1126.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1127.         IMPORT_CFM_FUNCTION SetIconFamilyData
  1128.     ENDIF
  1129.  
  1130.  
  1131.  
  1132. ;   GetIconFamilyData
  1133. ;   Return a copy of the data in the icon family.
  1134. ;   The type can be one of the icon type, or 'PICT'
  1135. ;   The data will be returned uncompressed.
  1136.  
  1137.  
  1138.  
  1139. ;
  1140. ; pascal OSErr GetIconFamilyData(IconFamilyHandle iconFamily, OSType iconType, Handle h)
  1141. ;
  1142.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1143.         Macro
  1144.         _GetIconFamilyData
  1145.             moveq               #49,D0
  1146.             dc.w                $AA75
  1147.         EndM
  1148.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1149.         IMPORT_CFM_FUNCTION GetIconFamilyData
  1150.     ENDIF
  1151.  
  1152.  
  1153.  
  1154. ;  ==============================================================================
  1155. ;   Reference counting
  1156. ;  ==============================================================================
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162. ;   GetIconRefOwners
  1163. ;   
  1164. ;   This routine returns the reference count for the IconRef, or number of owners.
  1165. ;   
  1166. ;   A valid IconRef always has at least one owner.
  1167.  
  1168.  
  1169.  
  1170. ;
  1171. ; pascal OSErr GetIconRefOwners(IconRef theIconRef, UInt16 *owners)
  1172. ;
  1173.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1174.         Macro
  1175.         _GetIconRefOwners
  1176.             moveq               #11,D0
  1177.             dc.w                $AA75
  1178.         EndM
  1179.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1180.         IMPORT_CFM_FUNCTION GetIconRefOwners
  1181.     ENDIF
  1182.  
  1183.  
  1184.  
  1185. ;   AcquireIconRef
  1186. ;   This routine increments the reference count for the IconRef
  1187.  
  1188.  
  1189.  
  1190. ;
  1191. ; pascal OSErr AcquireIconRef(IconRef theIconRef)
  1192. ;
  1193.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1194.         Macro
  1195.         _AcquireIconRef
  1196.             moveq               #39,D0
  1197.             dc.w                $AA75
  1198.         EndM
  1199.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1200.         IMPORT_CFM_FUNCTION AcquireIconRef
  1201.     ENDIF
  1202.  
  1203.  
  1204.  
  1205.  
  1206. ;   ReleaseIconRef
  1207. ;   
  1208. ;   This routine decrements the reference count for the IconRef.
  1209. ;   
  1210. ;   When the reference count reaches 0, all memory allocated for the icon
  1211. ;   is disposed. Any subsequent use of the IconRef is invalid.
  1212.  
  1213.  
  1214.  
  1215. ;
  1216. ; pascal OSErr ReleaseIconRef(IconRef theIconRef)
  1217. ;
  1218.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1219.         Macro
  1220.         _ReleaseIconRef
  1221.             moveq               #40,D0
  1222.             dc.w                $AA75
  1223.         EndM
  1224.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1225.         IMPORT_CFM_FUNCTION ReleaseIconRef
  1226.     ENDIF
  1227.  
  1228.  
  1229.  
  1230.  
  1231. ;  ==============================================================================
  1232. ;   Getting an IconRef
  1233. ;  ==============================================================================
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239. ;   GetIconRefFromFile
  1240. ;   
  1241. ;   This routine returns an icon ref for the specified file, folder or volume.
  1242. ;   The label information is provided separately, since two files with the same icon 
  1243. ;   but a different label would share the same iconRef. The label can be used in 
  1244. ;   PlotIconRef() for example.
  1245. ;   
  1246. ;   Use this routine if you have no information about the file system object. If 
  1247. ;   you have already done a GetCatInfo on the file and want to save some I/O, 
  1248. ;   call GetIconRefFromFolder() if you know it's a folder with no custom icon or 
  1249. ;   call GetIconRef() if it's a file with no custom icon.
  1250. ;   This routine increments the reference count of the returned IconRef. Call 
  1251. ;   ReleaseIconRef() when you're done with it.
  1252.  
  1253.  
  1254.  
  1255. ;
  1256. ; pascal OSErr GetIconRefFromFile(const FSSpec *theFile, IconRef *theIconRef, SInt16 *theLabel)
  1257. ;
  1258.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1259.         Macro
  1260.         _GetIconRefFromFile
  1261.             moveq               #2,D0
  1262.             dc.w                $AA75
  1263.         EndM
  1264.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1265.         IMPORT_CFM_FUNCTION GetIconRefFromFile
  1266.     ENDIF
  1267.  
  1268.  
  1269.  
  1270. ;   GetBaseIconRefFromFile
  1271. ;   
  1272. ;   This routine returns the base icon ref for a file, that is, the icon 
  1273. ;   without any badge applied to it. In most cases, you should call 
  1274. ;   GetIconRefFromFile.
  1275.  
  1276.  
  1277. ;
  1278. ; pascal OSErr GetBaseIconRefFromFile(const FSSpec *theFile, IconRef *theIconRef, SInt16 *theLabel)
  1279. ;
  1280.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1281.         Macro
  1282.         _GetBaseIconRefFromFile
  1283.             moveq               #46,D0
  1284.             dc.w                $AA75
  1285.         EndM
  1286.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1287.         IMPORT_CFM_FUNCTION GetBaseIconRefFromFile
  1288.     ENDIF
  1289.  
  1290.  
  1291.  
  1292. ;   GetIconRef
  1293. ;   
  1294. ;   This routine returns an icon ref for an icon in the desktop database or
  1295. ;   for a registered icon.
  1296. ;   The system registers a set of icon such as the help icon with the creator 
  1297. ;   code kSystemIconCreator. See above for a list of the registered system types.
  1298. ;   The vRefNum is used as a hint on where to look for the icon first. Use 
  1299. ;   kOnSystemDisk if you don't know what to pass.
  1300. ;   This routine increments the reference count of the returned IconRef. Call 
  1301. ;   ReleaseIconRef() when you're done with it.
  1302.  
  1303.  
  1304.  
  1305. ;
  1306. ; pascal OSErr GetIconRef(SInt16 vRefNum, OSType creator, OSType iconType, IconRef *theIconRef)
  1307. ;
  1308.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1309.         Macro
  1310.         _GetIconRef
  1311.             moveq               #33,D0
  1312.             dc.w                $AA75
  1313.         EndM
  1314.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1315.         IMPORT_CFM_FUNCTION GetIconRef
  1316.     ENDIF
  1317.  
  1318.  
  1319.  
  1320.  
  1321. ;   GetIconRefFromFolder
  1322. ;   
  1323. ;   This routine returns an icon ref for a folder with no custom icon.
  1324. ;   Use the more generic, but slightly slower, GetIconRefFromFile() if
  1325. ;   you don't already have the necessary info about the file.
  1326. ;   Attributes should be CInfoPBRec.dirInfo.ioFlAttrib for this folder.
  1327. ;   Access privileges should be CInfoPBRec.dirInfo.ioACUser for this folder.
  1328. ;   This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1329. ;   when you're done with it.
  1330.  
  1331.  
  1332.  
  1333. ;
  1334. ; pascal OSErr GetIconRefFromFolder(SInt16 vRefNum, SInt32 parentFolderID, SInt32 folderID, SInt8 attributes, SInt8 accessPrivileges, IconRef *theIconRef)
  1335. ;
  1336.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1337.         Macro
  1338.         _GetIconRefFromFolder
  1339.             moveq               #34,D0
  1340.             dc.w                $AA75
  1341.         EndM
  1342.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1343.         IMPORT_CFM_FUNCTION GetIconRefFromFolder
  1344.     ENDIF
  1345.  
  1346.  
  1347.  
  1348.  
  1349. ;  ==============================================================================
  1350. ;   Adding and modifying IconRef
  1351. ;  ==============================================================================
  1352.  
  1353.  
  1354.  
  1355.  
  1356.  
  1357. ;   RegisterIconRefFromIconFamily
  1358. ;   This routine adds a new entry to the IconRef registry. Other clients will be 
  1359. ;   able to access it using the (creator, iconType) pair specified here.
  1360. ;   Lower-case creators are reserved for the system.
  1361. ;   Consider using RegisterIconRefFromResource() if possible, since the data 
  1362. ;   registered using RegisterIconRefFromFamily() cannot be purged.
  1363. ;   The iconFamily data is copied and the caller is reponsible for disposing of it.
  1364. ;   This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1365. ;   when you're done with it.
  1366.  
  1367.  
  1368.  
  1369. ;
  1370. ; pascal OSErr RegisterIconRefFromIconFamily(OSType creator, OSType iconType, IconFamilyHandle iconFamily, IconRef *theIconRef)
  1371. ;
  1372.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1373.         Macro
  1374.         _RegisterIconRefFromIconFamily
  1375.             moveq               #28,D0
  1376.             dc.w                $AA75
  1377.         EndM
  1378.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1379.         IMPORT_CFM_FUNCTION RegisterIconRefFromIconFamily
  1380.     ENDIF
  1381.  
  1382.  
  1383.  
  1384. ;   RegisterIconRefFromResource
  1385. ;   
  1386. ;   Registers an IconRef from a resouce file.  
  1387. ;   The icon data to be fetched is either classic icon data or an icon family.  
  1388. ;   The 'icns' icon family is searched for before the classic icon data.
  1389. ;   This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1390. ;   when you're done with it.
  1391.  
  1392.  
  1393.  
  1394. ;
  1395. ; pascal OSErr RegisterIconRefFromResource(OSType creator, OSType iconType, const FSSpec *resourceFile, SInt16 resourceID, IconRef *theIconRef)
  1396. ;
  1397.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1398.         Macro
  1399.         _RegisterIconRefFromResource
  1400.             moveq               #35,D0
  1401.             dc.w                $AA75
  1402.         EndM
  1403.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1404.         IMPORT_CFM_FUNCTION RegisterIconRefFromResource
  1405.     ENDIF
  1406.  
  1407.  
  1408.  
  1409. ;   UnregisterIconRef
  1410. ;   
  1411. ;   Removes the specified icon from the icon cache (if there are no users of it).  
  1412. ;   If some clients are using this iconRef, then the IconRef will be removed when the 
  1413. ;   last user calls ReleaseIconRef.
  1414.  
  1415.  
  1416.  
  1417. ;
  1418. ; pascal OSErr UnregisterIconRef(OSType creator, OSType iconType)
  1419. ;
  1420.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1421.         Macro
  1422.         _UnregisterIconRef
  1423.             moveq               #8,D0
  1424.             dc.w                $AA75
  1425.         EndM
  1426.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1427.         IMPORT_CFM_FUNCTION UnregisterIconRef
  1428.     ENDIF
  1429.  
  1430.  
  1431.  
  1432.  
  1433. ;   UpdateIconRef
  1434. ;   
  1435. ;   Call this routine to force an update of the data for iconRef.
  1436. ;   
  1437. ;   For example after changing an icon in the desktop database or changing the custom 
  1438. ;   icon of a file. Note that after _adding_ a custom icon to file or folder, you 
  1439. ;   need to call GetIconRefFromFile() to get a new IconRef specific to this file. 
  1440. ;   
  1441. ;   This routine does nothing if the IconRef is a registered icon.
  1442.  
  1443.  
  1444.  
  1445. ;
  1446. ; pascal OSErr UpdateIconRef(IconRef theIconRef)
  1447. ;
  1448.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1449.         Macro
  1450.         _UpdateIconRef
  1451.             moveq               #9,D0
  1452.             dc.w                $AA75
  1453.         EndM
  1454.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1455.         IMPORT_CFM_FUNCTION UpdateIconRef
  1456.     ENDIF
  1457.  
  1458.  
  1459.  
  1460.  
  1461. ;   OverrideIconRefFromResource
  1462. ;   
  1463. ;   This routines replaces the bitmaps of the specified IconRef with the ones
  1464. ;   in the specified resource file.
  1465.  
  1466.  
  1467.  
  1468. ;
  1469. ; pascal OSErr OverrideIconRefFromResource(IconRef theIconRef, const FSSpec *resourceFile, SInt16 resourceID)
  1470. ;
  1471.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1472.         Macro
  1473.         _OverrideIconRefFromResource
  1474.             moveq               #42,D0
  1475.             dc.w                $AA75
  1476.         EndM
  1477.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1478.         IMPORT_CFM_FUNCTION OverrideIconRefFromResource
  1479.     ENDIF
  1480.  
  1481.  
  1482.  
  1483.  
  1484. ;   OverrideIconRef
  1485. ;   
  1486. ;   This routines replaces the bitmaps of the specified IconRef with the ones
  1487. ;   from the new IconRef.
  1488.  
  1489.  
  1490.  
  1491. ;
  1492. ; pascal OSErr OverrideIconRef(IconRef oldIconRef, IconRef newIconRef)
  1493. ;
  1494.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1495.         Macro
  1496.         _OverrideIconRef
  1497.             moveq               #43,D0
  1498.             dc.w                $AA75
  1499.         EndM
  1500.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1501.         IMPORT_CFM_FUNCTION OverrideIconRef
  1502.     ENDIF
  1503.  
  1504.  
  1505.  
  1506. ;   RemoveIconRefOverride
  1507. ;   This routine remove an override if one was applied to the icon and 
  1508. ;   reverts back to the original bitmap data.
  1509.  
  1510.  
  1511.  
  1512. ;
  1513. ; pascal OSErr RemoveIconRefOverride(IconRef theIconRef)
  1514. ;
  1515.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1516.         Macro
  1517.         _RemoveIconRefOverride
  1518.             moveq               #30,D0
  1519.             dc.w                $AA75
  1520.         EndM
  1521.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1522.         IMPORT_CFM_FUNCTION RemoveIconRefOverride
  1523.     ENDIF
  1524.  
  1525.  
  1526.  
  1527.  
  1528. ;  ==============================================================================
  1529. ;   Creating composite IconRef
  1530. ;  ==============================================================================
  1531.  
  1532.  
  1533.  
  1534.  
  1535.  
  1536. ;   CompositeIconRef
  1537. ;   
  1538. ;   Superimposes an IconRef on top of another one
  1539.  
  1540.  
  1541.  
  1542. ;
  1543. ; pascal OSErr CompositeIconRef(IconRef backgroundIconRef, IconRef foregroundIconRef, IconRef *compositeIconRef)
  1544. ;
  1545.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1546.         Macro
  1547.         _CompositeIconRef
  1548.             moveq               #20,D0
  1549.             dc.w                $AA75
  1550.         EndM
  1551.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1552.         IMPORT_CFM_FUNCTION CompositeIconRef
  1553.     ENDIF
  1554.  
  1555.  
  1556.  
  1557. ;   IsIconRefComposite
  1558. ;   Indicates if a given icon ref is a composite of two other icon refs (and which ones)
  1559. ;   If it isn't a composite, backgroundIconRef and foreGroundIconRef will be 0.
  1560.  
  1561.  
  1562.  
  1563. ;
  1564. ; pascal OSErr IsIconRefComposite(IconRef compositeIconRef, IconRef *backgroundIconRef, IconRef *foregroundIconRef)
  1565. ;
  1566.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1567.         Macro
  1568.         _IsIconRefComposite
  1569.             moveq               #26,D0
  1570.             dc.w                $AA75
  1571.         EndM
  1572.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1573.         IMPORT_CFM_FUNCTION IsIconRefComposite
  1574.     ENDIF
  1575.  
  1576.  
  1577.  
  1578.  
  1579. ;  ==============================================================================
  1580. ;   Using IconRef
  1581. ;  ==============================================================================
  1582.  
  1583.  
  1584.  
  1585.  
  1586. ;   IsValidIconRef
  1587. ;   Return true if the iconRef passed in is a valid icon ref
  1588.  
  1589.  
  1590.  
  1591. ;
  1592. ; pascal Boolean IsValidIconRef(IconRef theIconRef)
  1593. ;
  1594.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1595.         Macro
  1596.         _IsValidIconRef
  1597.             moveq               #14,D0
  1598.             dc.w                $AA75
  1599.         EndM
  1600.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1601.         IMPORT_CFM_FUNCTION IsValidIconRef
  1602.     ENDIF
  1603.  
  1604.  
  1605.  
  1606. ;   PlotIconRef
  1607. ;   
  1608. ;   This routine plots the IconRef.  It mostly takes the same parameters as PlotIconSuite.
  1609. ;   Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1610.  
  1611.  
  1612.  
  1613. ;
  1614. ; pascal OSErr PlotIconRef(const Rect *theRect, IconAlignmentType align, IconTransformType transform, IconServicesUsageFlags theIconServicesUsageFlags, IconRef theIconRef)
  1615. ;
  1616.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1617.         Macro
  1618.         _PlotIconRef
  1619.             moveq               #14,D0
  1620.             dc.w                $AA75
  1621.         EndM
  1622.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1623.         IMPORT_CFM_FUNCTION PlotIconRef
  1624.     ENDIF
  1625.  
  1626.  
  1627.  
  1628. ;   PtInIconRef
  1629. ;   
  1630. ;   This routine indicates if testPt would hit the icon designated by iconRef.
  1631. ;   It mostly takes the same parameters as PtInIconSuite.
  1632. ;   Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1633.  
  1634.  
  1635.  
  1636.  
  1637. ;
  1638. ; pascal Boolean PtInIconRef(const Point *testPt, const Rect *iconRect, IconAlignmentType align, IconServicesUsageFlags theIconServicesUsageFlags, IconRef theIconRef)
  1639. ;
  1640.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1641.         Macro
  1642.         _PtInIconRef
  1643.             moveq               #15,D0
  1644.             dc.w                $AA75
  1645.         EndM
  1646.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1647.         IMPORT_CFM_FUNCTION PtInIconRef
  1648.     ENDIF
  1649.  
  1650.  
  1651.  
  1652. ;   RectInIconRef
  1653. ;   
  1654. ;   This routine indicates if testRect would intersect the icon designated by iconRef.
  1655. ;   It mostly takes the same parameters as RectInIconSuite.
  1656. ;   Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1657.  
  1658.  
  1659.  
  1660.  
  1661. ;
  1662. ; pascal Boolean RectInIconRef(const Rect *testRect, const Rect *iconRect, IconAlignmentType align, IconServicesUsageFlags iconServicesUsageFlags, IconRef theIconRef)
  1663. ;
  1664.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1665.         Macro
  1666.         _RectInIconRef
  1667.             moveq               #16,D0
  1668.             dc.w                $AA75
  1669.         EndM
  1670.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1671.         IMPORT_CFM_FUNCTION RectInIconRef
  1672.     ENDIF
  1673.  
  1674.  
  1675.  
  1676. ;   IconRefToRgn
  1677. ;   
  1678. ;   This routine returns a region for the icon.
  1679. ;   It mostly takes the same parameters as IconSuiteToRgn.
  1680. ;   Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1681.  
  1682.  
  1683.  
  1684. ;
  1685. ; pascal OSErr IconRefToRgn(RgnHandle theRgn, const Rect *iconRect, IconAlignmentType align, IconServicesUsageFlags iconServicesUsageFlags, IconRef theIconRef)
  1686. ;
  1687.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1688.         Macro
  1689.         _IconRefToRgn
  1690.             moveq               #17,D0
  1691.             dc.w                $AA75
  1692.         EndM
  1693.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1694.         IMPORT_CFM_FUNCTION IconRefToRgn
  1695.     ENDIF
  1696.  
  1697.  
  1698.  
  1699. ;   GetIconSizesFromIconRef
  1700. ;   
  1701. ;   This routine returns an IconSelectorValue indicating the depths and sizes of 
  1702. ;   icon data which are actually available.  It takes an IconSelectorValue 
  1703. ;   indicating which sizes/depths the caller is interested and returns an 
  1704. ;   IconSelectorValue indicating which sizes/depths exist.
  1705. ;   
  1706. ;   Caution:
  1707. ;   
  1708. ;   This is potentially an extremely expensive call as IconServices may be forced 
  1709. ;   to attempt fetching the data for the IconRef's sizes/depths which may result 
  1710. ;   in hitting the local disk or even the network to obtain the data to determine 
  1711. ;   which sizes/depths actually exist.
  1712. ;   Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1713.  
  1714.  
  1715.  
  1716. ;
  1717. ; pascal OSErr GetIconSizesFromIconRef(IconSelectorValue iconSelectorInput, IconSelectorValue *iconSelectorOutputPtr, IconServicesUsageFlags iconServicesUsageFlags, IconRef theIconRef)
  1718. ;
  1719.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1720.         Macro
  1721.         _GetIconSizesFromIconRef
  1722.             moveq               #18,D0
  1723.             dc.w                $AA75
  1724.         EndM
  1725.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1726.         IMPORT_CFM_FUNCTION GetIconSizesFromIconRef
  1727.     ENDIF
  1728.  
  1729.  
  1730.  
  1731.  
  1732. ;  ==============================================================================
  1733. ;   Flushing IconRef data
  1734. ;  ==============================================================================
  1735.  
  1736.  
  1737.  
  1738.  
  1739.  
  1740. ;   FlushIconRefs
  1741. ;   
  1742. ;   Making this call will dispose of all the data for the specified icons if 
  1743. ;   the data can be reacquired, for example if the data is provided from a resource.
  1744. ;   '****' is a wildcard for all types or all creators.
  1745.  
  1746.  
  1747.  
  1748. ;
  1749. ; pascal OSErr FlushIconRefs(OSType creator, OSType iconType)
  1750. ;
  1751.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1752.         Macro
  1753.         _FlushIconRefs
  1754.             moveq               #41,D0
  1755.             dc.w                $AA75
  1756.         EndM
  1757.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1758.         IMPORT_CFM_FUNCTION FlushIconRefs
  1759.     ENDIF
  1760.  
  1761.  
  1762.  
  1763. ;   FlushIconRefsByVolume
  1764. ;   
  1765. ;   This routine disposes of the data for the icons related to the indicated volume
  1766. ;   if this data can be reacquired, for example if the data is provided from a 
  1767. ;   resource.
  1768.  
  1769.  
  1770.  
  1771. ;
  1772. ; pascal OSErr FlushIconRefsByVolume(SInt16 vRefNum)
  1773. ;
  1774.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1775.         Macro
  1776.         _FlushIconRefsByVolume
  1777.             moveq               #24,D0
  1778.             dc.w                $AA75
  1779.         EndM
  1780.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1781.         IMPORT_CFM_FUNCTION FlushIconRefsByVolume
  1782.     ENDIF
  1783.  
  1784.  
  1785.  
  1786.  
  1787. ;  ==============================================================================
  1788. ;   Controling custom icons
  1789. ;  ==============================================================================
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795. ;   SetCustomIconsEnabled
  1796. ;   
  1797. ;   Enable or disable custom icons on the specified volume.
  1798.  
  1799.  
  1800.  
  1801. ;
  1802. ; pascal OSErr SetCustomIconsEnabled(SInt16 vRefNum, Boolean enableCustomIcons)
  1803. ;
  1804.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1805.         Macro
  1806.         _SetCustomIconsEnabled
  1807.             moveq               #31,D0
  1808.             dc.w                $AA75
  1809.         EndM
  1810.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1811.         IMPORT_CFM_FUNCTION SetCustomIconsEnabled
  1812.     ENDIF
  1813.  
  1814.  
  1815.  
  1816. ;   GetCustomIconsEnabled
  1817. ;   
  1818. ;   Return true if custom icons are enabled on the specified volume, false otherwise.
  1819.  
  1820.  
  1821.  
  1822. ;
  1823. ; pascal OSErr GetCustomIconsEnabled(SInt16 vRefNum, Boolean *customIconsEnabled)
  1824. ;
  1825.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1826.         Macro
  1827.         _GetCustomIconsEnabled
  1828.             moveq               #32,D0
  1829.             dc.w                $AA75
  1830.         EndM
  1831.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1832.         IMPORT_CFM_FUNCTION GetCustomIconsEnabled
  1833.     ENDIF
  1834.  
  1835.  
  1836.  
  1837. ;   SetCustomIconFamily
  1838. ;   Sets the custom icon of a file or folder.
  1839. ;   AliasIcon should be true to indicate you want to specify the 
  1840. ;   appearance that the alias file should have. You can further
  1841. ;   override the appearance of the alias by specifying a custom 
  1842. ;   icon.
  1843.  
  1844.  
  1845. ;
  1846. ; pascal OSErr SetCustomIconFamily(const FSSpec *theFile, Boolean aliasIcon, IconRef customIcon)
  1847. ;
  1848.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1849.         Macro
  1850.         _SetCustomIconFamily
  1851.             moveq               #47,D0
  1852.             dc.w                $AA75
  1853.         EndM
  1854.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1855.         IMPORT_CFM_FUNCTION SetCustomIconFamily
  1856.     ENDIF
  1857.  
  1858.  
  1859.     ENDIF ; __ICONS__ 
  1860.  
  1861.